Add search request timeouts for correlations workflows #893

goyamegh · 2024-03-07T22:33:09Z

Description

Add search request timeouts to close hanging tasks for correlations waiting on searches.

Issues Resolved

Check List

New functionality includes testing.
- All tests pass
New functionality has been documented.
- New functionality has javadoc added
Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Megha Goyal <[email protected]>

codecov · 2024-03-07T22:49:25Z

Codecov Report

Attention: Patch coverage is 0% with 57 lines in your changes are missing coverage. Please review.

❗ No coverage uploaded for pull request base (main@689760e). Click here to learn what that means.
Report is 1 commits behind head on main.

Files	Patch %	Lines
...ics/transport/TransportCorrelateFindingAction.java	0.00%	37 Missing ⚠️
...yanalytics/correlation/VectorEmbeddingsEngine.java	0.00%	14 Missing ⚠️
...arch/securityanalytics/correlation/JoinEngine.java	0.00%	6 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #893   +/-   ##
=======================================
  Coverage        ?   25.01%           
  Complexity      ?     1047           
=======================================
  Files           ?      277           
  Lines           ?    12771           
  Branches        ?     1391           
=======================================
  Hits            ?     3195           
  Misses          ?     9304           
  Partials        ?      272

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Signed-off-by: Megha Goyal <[email protected]>

eirsep · 2024-03-08T05:30:16Z

src/main/java/org/opensearch/securityanalytics/correlation/VectorEmbeddingsEngine.java

+        if (logTypes.get(detectorType) == null ) {
+            log.debug("[PERF-DEBUG] insertOrphanFindings detector type {} {}", detectorType, finding.getId());
+            for (String key : logTypes.keySet()) {
+                log.debug("[PERF-DEBUG] keys {}", key);


Plz remove perf_debug prefix in all logs

Fixed logging.

eirsep

Lgtm
Minor comments

eirsep · 2024-03-08T05:32:11Z

src/main/java/org/opensearch/securityanalytics/correlation/VectorEmbeddingsEngine.java

@@ -407,6 +417,8 @@ public void insertOrphanFindings(String detectorType, Finding finding, float tim
                                            } catch (Exception ex) {
                                                onFailure(ex);
                                            }
+                                        } else {
+                                            onFailure(new OpenSearchStatusException("Indexing failed", RestStatus.INTERNAL_SERVER_ERROR));


Can log message convey that search timed out hence indexing failed

Fixed the messaging to include the response itself as timeout can be one of the responses.

eirsep · 2024-03-08T05:35:04Z

src/main/java/org/opensearch/securityanalytics/correlation/VectorEmbeddingsEngine.java

@@ -94,6 +94,7 @@ public void insertCorrelatedFindings(String detectorType, Finding finding, Strin
                request.indices(CorrelationIndices.CORRELATION_HISTORY_INDEX_PATTERN_REGEXP);
                request.source(searchSourceBuilder);
                request.preference(Preference.PRIMARY_FIRST.type());
+                request.setCancelAfterTimeInterval(TimeValue.timeValueSeconds(10L));


Why such an aggressive timeout

We were seeing correlations tasks hanging around due to searches. Since these are system indices, we have configured a standard 10 second timeout for now, but we can discuss and make it configurable in future.

eirsep · 2024-03-08T05:36:09Z

src/main/java/org/opensearch/securityanalytics/transport/TransportCorrelateFindingAction.java

-                        Map<String, Object> hitSource = response.getHits().getHits()[0].getSourceAsMap();
-                        long scoreTimestamp = (long) hitSource.get("scoreTimestamp");
+                        } else {
+                            String id = response.getHits().getHits()[0].getId();


Empty check?(i see u didnt change the code but better to add)

I added this check intentionally as I was observing that the flow was continuing even when we throw the exception in the if block above. So, putting this in the else block will avoid the ArrayOutOfBoundsException then.

Signed-off-by: Megha Goyal <[email protected]>

eirsep

typically timeout should be a setting but we can do a quick follow up for that

opensearch-trigger-bot · 2024-03-08T22:32:48Z

The backport to 2.11 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.11 2.11
# Navigate to the new working tree
cd .worktrees/backport-2.11
# Create a new branch
git switch --create backport/backport-893-to-2.11
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 75c442902f2715e4b41f96e77230ac773d0eb2d2
# Push it to GitHub
git push --set-upstream origin backport/backport-893-to-2.11
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.11

Then, create a pull request where the base branch is 2.11 and the compare/head branch is backport/backport-893-to-2.11.

* Reinstating more leaks plugged-in for correlations workflows Signed-off-by: Megha Goyal <[email protected]> * Add search timeouts to all correlation searches Signed-off-by: Megha Goyal <[email protected]> * Fix logging and exception messages Signed-off-by: Megha Goyal <[email protected]> * Change search timeout to 30 seconds Signed-off-by: Megha Goyal <[email protected]> --------- Signed-off-by: Megha Goyal <[email protected]> (cherry picked from commit 75c4429)

* Reinstating more leaks plugged-in for correlations workflows Signed-off-by: Megha Goyal <[email protected]> * Add search timeouts to all correlation searches Signed-off-by: Megha Goyal <[email protected]> * Fix logging and exception messages Signed-off-by: Megha Goyal <[email protected]> * Change search timeout to 30 seconds Signed-off-by: Megha Goyal <[email protected]> --------- Signed-off-by: Megha Goyal <[email protected]> (cherry picked from commit 75c4429) Co-authored-by: Megha Goyal <[email protected]>

Signed-off-by: Joanne Wang <[email protected]> (cherry picked from commit 4d4f5e3) Co-authored-by: Joanne Wang <[email protected]> Reduce log level for informative message (opensearch-project#203) (opensearch-project#833) Signed-off-by: Enrico Tröger <[email protected]> Co-authored-by: Enrico Tröger <[email protected]> Updated alert creation following common-utils PR 584. (opensearch-project#837) (opensearch-project#839) Signed-off-by: AWSHurneyt <[email protected]> (cherry picked from commit 8adb9c3) Co-authored-by: AWSHurneyt <[email protected]> Release notes for 2.12.0 (opensearch-project#834) (opensearch-project#841) * release notes for 2.12 Signed-off-by: Joanne Wang <[email protected]> * update release notes Signed-off-by: Joanne Wang <[email protected]> * update release notes Signed-off-by: Joanne Wang <[email protected]> --------- Signed-off-by: Joanne Wang <[email protected]> (cherry picked from commit 414484a) Co-authored-by: Joanne Wang <[email protected]> Remove blocking calls and change threat intel feed flow to event driven (opensearch-project#871) (opensearch-project#876) * remove actionGet() and change threat intel feed flow to event driven Signed-off-by: Surya Sashank Nistala <[email protected]> * fix javadocs Signed-off-by: Surya Sashank Nistala <[email protected]> * revert try catch removals Signed-off-by: Surya Sashank Nistala <[email protected]> * use action listener wrap() in detector threat intel code paths Signed-off-by: Surya Sashank Nistala <[email protected]> * add try catch Signed-off-by: Surya Sashank Nistala <[email protected]> --------- Signed-off-by: Surya Sashank Nistala <[email protected]> (cherry picked from commit 172d58d) Co-authored-by: Surya Sashank Nistala <[email protected]> Fail the flow the when detectot type is missing in the log types index (opensearch-project#845) (opensearch-project#857) Signed-off-by: Megha Goyal <[email protected]> (cherry picked from commit 8d19912) Co-authored-by: Megha Goyal <[email protected]> [BUG] ArrayIndexOutOfBoundsException for inconsistent detector index behavior (opensearch-project#843) (opensearch-project#858) * Catch ArrayIndexOutOfBoundsException when detector is missing Signed-off-by: Megha Goyal <[email protected]> * Add a check on SearchHits.getHits() length Signed-off-by: Megha Goyal <[email protected]> * Remove index out of bounds exception Signed-off-by: Megha Goyal <[email protected]> --------- Signed-off-by: Megha Goyal <[email protected]> (cherry picked from commit 0ef8543) Co-authored-by: Megha Goyal <[email protected]> Backport opensearch-project#873 and opensearch-project#789 (opensearch-project#895) * support object fields in aggregation based sigma rules (opensearch-project#789) Signed-off-by: Subhobrata Dey <[email protected]> * Pass rule field names in doc level queries during monitor/creation. Remove blocking actionGet() calls (opensearch-project#873) * pass query field names in doc level queries during monitor creation/updation Signed-off-by: Surya Sashank Nistala <[email protected]> * remove actionGet() and change get index mapping call to event driven flow Signed-off-by: Surya Sashank Nistala <[email protected]> * fix chained findings monitor Signed-off-by: Surya Sashank Nistala <[email protected]> * add finding mappings Signed-off-by: Surya Sashank Nistala <[email protected]> * remove test messages from logs Signed-off-by: Surya Sashank Nistala <[email protected]> * revert build.gradle change Signed-off-by: Surya Sashank Nistala <[email protected]> --------- Signed-off-by: Surya Sashank Nistala <[email protected]> --------- Signed-off-by: Subhobrata Dey <[email protected]> Signed-off-by: Surya Sashank Nistala <[email protected]> Co-authored-by: Subhobrata Dey <[email protected]> Fix duplicate ecs mappings which returns incorrect log index field in mapping view API (opensearch-project#786) (opensearch-project#788) (opensearch-project#898) * field mapping changes * add integ test * turn unmappedfieldaliases as set and add integ test * add comments * fix integ tests * moved logic to method for better readability --------- Signed-off-by: Joanne Wang <[email protected]> Add throw for empty strings in rules with modifier contains, startwith, and endswith (opensearch-project#860) (opensearch-project#896) * add validation for empty strings with contains, startswith and endswith modifiers * throw exception if empty string with contains, startswith, or endswith * change var name * add modifiers to log --------- Signed-off-by: Joanne Wang <[email protected]> Add an "exists" check for "not" condition in sigma rules (opensearch-project#852) (opensearch-project#897) * test design Signed-off-by: Joanne Wang <[email protected]> * working version Signed-off-by: Joanne Wang <[email protected]> * cleaning up Signed-off-by: Joanne Wang <[email protected]> * testing Signed-off-by: Joanne Wang <[email protected]> * working version Signed-off-by: Joanne Wang <[email protected]> * working version Signed-off-by: Joanne Wang <[email protected]> * refactored querybackend Signed-off-by: Joanne Wang <[email protected]> * working on tests Signed-off-by: Joanne Wang <[email protected]> * fixed alerting and finding tests Signed-off-by: Joanne Wang <[email protected]> * fix correlation tests Signed-off-by: Joanne Wang <[email protected]> * working all tests Signed-off-by: Joanne Wang <[email protected]> * moved test and changed alias for adldap Signed-off-by: Joanne Wang <[email protected]> * added more tests Signed-off-by: Joanne Wang <[email protected]> * cleanup code Signed-off-by: Joanne Wang <[email protected]> * remove exists flag Signed-off-by: Joanne Wang <[email protected]> --------- Signed-off-by: Joanne Wang <[email protected]> (cherry picked from commit 656a5fe) Co-authored-by: Joanne Wang <[email protected]> Add goyamegh as a maintainer (opensearch-project#868) (opensearch-project#899) Signed-off-by: Megha Goyal <[email protected]> Refactor invocation of Action listeners in correlations (opensearch-project#880) (opensearch-project#900) * Refactor invocation of Action listeners in correlations * Close hanging tasks in correlations workflow * Logging finding id and monitor id in error logs --------- Signed-off-by: Megha Goyal <[email protected]> Add search request timeouts for correlations workflows (opensearch-project#893) (opensearch-project#901) * Reinstating more leaks plugged-in for correlations workflows Signed-off-by: Megha Goyal <[email protected]> * Add search timeouts to all correlation searches Signed-off-by: Megha Goyal <[email protected]> * Fix logging and exception messages Signed-off-by: Megha Goyal <[email protected]> * Change search timeout to 30 seconds Signed-off-by: Megha Goyal <[email protected]> --------- Signed-off-by: Megha Goyal <[email protected]> (cherry picked from commit 75c4429) Co-authored-by: Megha Goyal <[email protected]>

opensearch-trigger-bot · 2024-03-11T22:25:17Z

The backport to 2.7 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.7 2.7
# Navigate to the new working tree
cd .worktrees/backport-2.7
# Create a new branch
git switch --create backport/backport-893-to-2.7
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 75c442902f2715e4b41f96e77230ac773d0eb2d2
# Push it to GitHub
git push --set-upstream origin backport/backport-893-to-2.7
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.7

Then, create a pull request where the base branch is 2.7 and the compare/head branch is backport/backport-893-to-2.7.

opensearch-trigger-bot · 2024-03-11T22:25:20Z

The backport to 2.9 failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-2.9 2.9
# Navigate to the new working tree
cd .worktrees/backport-2.9
# Create a new branch
git switch --create backport/backport-893-to-2.9
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 75c442902f2715e4b41f96e77230ac773d0eb2d2
# Push it to GitHub
git push --set-upstream origin backport/backport-893-to-2.9
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-2.9

Then, create a pull request where the base branch is 2.9 and the compare/head branch is backport/backport-893-to-2.9.

* Reinstating more leaks plugged-in for correlations workflows Signed-off-by: Megha Goyal <[email protected]> * Add search timeouts to all correlation searches Signed-off-by: Megha Goyal <[email protected]> * Fix logging and exception messages Signed-off-by: Megha Goyal <[email protected]> * Change search timeout to 30 seconds Signed-off-by: Megha Goyal <[email protected]> --------- Signed-off-by: Megha Goyal <[email protected]>

Reinstating more leaks plugged-in for correlations workflows

0355f8f

Signed-off-by: Megha Goyal <[email protected]>

goyamegh requested review from amsiglan, AWSHurneyt, getsaurabh02, lezzago, praveensameneni, sbcd90, eirsep, jowg-amazon, engechas and riysaxen-amzn as code owners March 7, 2024 22:33

Add search timeouts to all correlation searches

998c075

Signed-off-by: Megha Goyal <[email protected]>

goyamegh changed the title ~~Reinstating more leaks plugged-in for correlations workflows~~ Add search request timeouts for correlations workflows Mar 8, 2024

engechas previously approved these changes Mar 8, 2024

View reviewed changes

eirsep reviewed Mar 8, 2024

View reviewed changes

eirsep requested changes Mar 8, 2024

View reviewed changes

Fix logging and exception messages

87cf6ca

Signed-off-by: Megha Goyal <[email protected]>

goyamegh dismissed engechas’s stale review via 87cf6ca March 8, 2024 22:01

Change search timeout to 30 seconds

7788f84

Signed-off-by: Megha Goyal <[email protected]>

eirsep approved these changes Mar 8, 2024

View reviewed changes

goyamegh added backport 2.x backport 2.11 labels Mar 8, 2024

engechas approved these changes Mar 8, 2024

View reviewed changes

riysaxen-amzn approved these changes Mar 8, 2024

View reviewed changes

goyamegh merged commit 75c4429 into opensearch-project:main Mar 8, 2024
11 of 20 checks passed

opensearch-trigger-bot bot mentioned this pull request Mar 8, 2024

[Backport 2.x] Add search request timeouts for correlations workflows #901

Merged

goyamegh added backport 2.7 backport 2.9 backports to 2.9 labels Mar 11, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add search request timeouts for correlations workflows #893

Add search request timeouts for correlations workflows #893

goyamegh commented Mar 7, 2024 •

edited

Loading

codecov bot commented Mar 7, 2024 •

edited

Loading

eirsep Mar 8, 2024 •

edited

Loading

goyamegh Mar 8, 2024

eirsep left a comment

eirsep Mar 8, 2024

goyamegh Mar 8, 2024

eirsep Mar 8, 2024

goyamegh Mar 8, 2024

eirsep Mar 8, 2024

goyamegh Mar 8, 2024

eirsep left a comment

opensearch-trigger-bot bot commented Mar 8, 2024

opensearch-trigger-bot bot commented Mar 11, 2024

opensearch-trigger-bot bot commented Mar 11, 2024

Add search request timeouts for correlations workflows #893

Add search request timeouts for correlations workflows #893

Conversation

goyamegh commented Mar 7, 2024 • edited Loading

Description

Issues Resolved

Check List

codecov bot commented Mar 7, 2024 • edited Loading

Codecov Report

eirsep Mar 8, 2024 • edited Loading

Choose a reason for hiding this comment

goyamegh Mar 8, 2024

Choose a reason for hiding this comment

eirsep left a comment

Choose a reason for hiding this comment

eirsep Mar 8, 2024

Choose a reason for hiding this comment

goyamegh Mar 8, 2024

Choose a reason for hiding this comment

eirsep Mar 8, 2024

Choose a reason for hiding this comment

goyamegh Mar 8, 2024

Choose a reason for hiding this comment

eirsep Mar 8, 2024

Choose a reason for hiding this comment

goyamegh Mar 8, 2024

Choose a reason for hiding this comment

eirsep left a comment

Choose a reason for hiding this comment

opensearch-trigger-bot bot commented Mar 8, 2024

opensearch-trigger-bot bot commented Mar 11, 2024

opensearch-trigger-bot bot commented Mar 11, 2024

goyamegh commented Mar 7, 2024 •

edited

Loading

codecov bot commented Mar 7, 2024 •

edited

Loading

eirsep Mar 8, 2024 •

edited

Loading